home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / os2 / xdsn217.zip / readme.1st
Text File  |  1996-07-09  |  5KB  |  164 lines
  1. README.1ST                       Copyright (c) 1991,96 xTech Ltd
  2. ----------------------------------------------------------------
  3.  
  4.                  Native XDS-x86 OS/2 Edition
  5.                  ---------------------------
  6.                      v2.17 (pre-release)
  7.  
  8.                         Read Me First!
  9.  
  10.  
  11. 1. Installation
  12. ---------------
  13.  
  14. To install this pre-release, create a new directory (e.g. c:\xds)
  15. and unzip the archive to it. NOTE: if you are using PKUNZIP*, use
  16. the -d option, to have the files unzipped into directories.
  17.  
  18. Example
  19.  
  20.     c:
  21.     mkdir \XDS
  22.     cd \XDS
  23.     unzip c:\xdsn217_os2.zip
  24.  
  25. The following directory structure will be created:
  26.  
  27. C:\XDS\
  28.         DOC             useful *.txt and *.inf files
  29.         BIN             executable and system files
  30.         DEF             library definition modules
  31.         CDEF            ANSI C interface library definition modules
  32.         ISODEF          ISO library definition modules
  33.         LIB             "*.lib" files
  34.         ODEF            Oberon-2 libraries pseudo-definition modules
  35.         SYM             symbol files
  36.         SAMPLES         Modula-2/Oberon-2 code samples
  37.  
  38. In  the  following text we assume that you have chosen the C:\XDS
  39. directory for installation. If another directory was used, please
  40. use the name of that directory instead.
  41.  
  42. Now, edit your CONFIG.SYS file:
  43.  
  44.  - add the directory C:\XDS\BIN to executables search PATH
  45.  
  46.  - add the directory C:\XDS\DOC to BOOKSHELF environment variable
  47.    which is used by on-line documentation viewer.
  48.  
  49. Shutdown and reboot your system to make the changes work.
  50.  
  51.  
  52. 1.1. Setting up the IDE profile path
  53.  
  54. The IDE keeps its configuration information in profiles, which may
  55. reside in any directory. In case of network installation, you may
  56. store the profiles either:
  57.  
  58.   - on local disks, to have unique profiles on each workstation
  59.  
  60.   - in users' network directories, to have unique profiles for each
  61.     user, regardless of the workstation.
  62.  
  63. To specify a directory for profiles, type:
  64.  
  65.     xds /i <directory>
  66.  
  67. at the OS/2 command prompt and press Enter.
  68.  
  69.  
  70. 1.2. Creating Workplace Shell objects (optional)
  71.  
  72. To create the XDS desktop folder and WPS objects, type
  73.  
  74.     xdsdesk
  75.  
  76. at the OS/2 command prompt and press Enter.
  77.  
  78.  
  79. 1.3. Expanding file names (optional)
  80.  
  81. Names af symbol files and files containing definition modules are
  82. initially FAT-compatible (limited to 8.3). If you have installed
  83. the XDS package onto file system which supports long file names
  84. (e.g. HPFS), you may expand these file names. Type
  85.  
  86.     fatfs -
  87.  
  88. at the OS/2 command prompt and press Enter.
  89.  
  90. You may revert back to short file names any time later using the
  91. "fatfs +" command.
  92.  
  93.  
  94. 2. Creating the Working Directory
  95. ---------------------------------
  96.  
  97. To start working on a new project, create a new directory, make it
  98. current and invoke the "xdswork" script to create the redirection
  99. file and the appropriate subdirectories:
  100.  
  101.     c:
  102.     mkdir \XDSWORK
  103.     cd \XDSWORK
  104.     xdswork
  105.  
  106. If you intend to use the working directory to play with XDS sample
  107. programs, issue the "xdssamp" command instead of "xdswork". The file
  108. DOC\SAMPLES.TXT contains a brief description of all sample programs
  109. included.
  110.  
  111.  
  112. 3. How to start
  113. ----------------
  114.  
  115. To start the IDE, type
  116.  
  117.     xds
  118.  
  119. at the OS/2 command prompt and press Enter.
  120.  
  121. To start the compiler, type
  122.  
  123.     xc {options | modes} module_or_project_file {options | modes}
  124.  
  125. at the OS/2 command prompt and press Enter.
  126.  
  127. To view the on-line documentation, type
  128.  
  129.     view xdsug          XDS User's Guide
  130.     view isom2          ISO Modula-2 language reference
  131.     view isolib         ISO Modula-2 library reference
  132.  
  133. You can also use WPS objects if you have created them (see section 1.2.).
  134.  
  135.  
  136. 4. H2D
  137. ------
  138.  
  139. The H2D utility is a translator of C header files to Modula-2 definition
  140. modules. The version included in this pre-release is rather old and the
  141. documentation may be inconsistent. The current version has many differences
  142. so use the supplied one only for evaluation, on short files.
  143.  
  144. Note: the h2d.red file containing redirection to h2d.cfg must be present
  145.       in the current directory to make H2D work.
  146.  
  147.  
  148. 5. See also
  149. -----------
  150.  
  151. The following text files in the DOC subdirectory contain additional
  152. information:
  153.  
  154.     intro.txt        introduction to pre-release version of XDS
  155.     whatsnew.txt     what is new in this pre-release
  156.     problems.txt     possible problems, bug report
  157.     samples.txt      description of samples
  158.     os2api.txt       short remarks on OS/2 API support
  159.     bench.txt        benchmark testing results
  160.     xds.txt          pre-release version license policy
  161.  
  162. If you have created WPS objects (see 1.2.), you will find these
  163. files in the Readme 2nd subfolder.
  164.